2.x: fix/clarify the Observable class' javadoc #5432
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
vanniktech
approved these changes
Jun 21, 2017
| * therefore accept general {@code ObservableSource}s directly and allow direct interoperation with other | ||
| * Reactive-Streams implementations. | ||
| * Many operators in the class accept {@code ObservableSource}(s), the base reactive interface | ||
| * for such non-backpressured flows, which {@code Observable} itself extends as well. |
| * <p> | ||
| * The {@code Observable} follows the protocol | ||
| * <pre><code> | ||
| * onSubscribe onNext* (onError | onComplete)? |
There was a problem hiding this comment.
The parameters are omitted to avoid conflict with the regexp-like pattern
| * <pre><code> | ||
| * Disposable d = Observable.just("Hello world!") | ||
| * .delay(1, TimeUnit.SECONDS) | ||
| * .subscribeWith(new DisposableObserver<String>() { |
There was a problem hiding this comment.
The closing > doesn't need escaping.
Codecov Report
@@ Coverage Diff @@
## 2.x #5432 +/- ##
============================================
+ Coverage 96.02% 96.07% +0.05%
- Complexity 5787 5801 +14
============================================
Files 631 631
Lines 41291 41291
Branches 5742 5742
============================================
+ Hits 39648 39669 +21
+ Misses 650 635 -15
+ Partials 993 987 -6
Continue to review full report at Codecov.
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR rewords the javadoc of the
Observableclass a bit and adds a couple of extra clarifying sentences.